Add path parameter to github-card shortcode #17469
Conversation
Review SummaryThis change looks good! The implementation cleanly adds an optional Code Quality ✅
ObservationsOpen Graph Image Limitation: When a src="https://opengraph.githubassets.com/1/{{ $repo }}"This is expected behavior since GitHub's Open Graph API doesn't generate preview images for specific paths, only for repositories. The preview card will show repository-level information while the link correctly navigates to the specified path. This might be slightly confusing to users, but it's a limitation of GitHub's API rather than an issue with this implementation. Recommendation✅ Approve - This is a useful enhancement that maintains backward compatibility and is well-documented. If you'd like any additional reviews or fixes, feel free to mention me (@claude). |
|
Your site preview for commit c738176 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-17469-c738176e.s3-website.us-west-2.amazonaws.com. |
Support linking to specific folders within a repo by adding `path` and `branch` parameters. The branch defaults to "main" so users only need to provide the folder path.
dirien
force-pushed
the
dirien/github-card-shortcode
branch
from
c738176 to
7dd8216
Compare
|
Your site preview for commit 7dd8216 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-17469-7dd82163.s3-website.us-west-2.amazonaws.com. |
3 participants
Summary
pathparameter to thegithub-cardshortcode, allowing links to specific folders or paths within a repository (e.g.,tree/master/example-folder)pathis provided, both the link URL and the displayed URL include the full pathTest plan
{{< github-card repo="owner/repo" >}}still works as before{{< github-card repo="owner/repo" path="tree/master/folder" >}}links to the correct URL and displays the full path